home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1544.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.3 KB  |  115 lines
  1. 134
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. XCopyProgress
  6. --- RECORDSEPARATOR ---
  7.  
  8. --- RECORDSEPARATOR ---
  9. (continued)
  10. --- RECORDSEPARATOR ---
  11.  
  12. --- RECORDSEPARATOR ---
  13. Notes:
  14. --- RECORDSEPARATOR ---
  15.  
  16. --- RECORDSEPARATOR ---
  17. A return value of 7 (Dest file is newer than Source file) can only be returned when 
  18. --- RECORDSEPARATOR ---
  19. Overwrite is "IfNewer". The other return values can be returned for all Overwrite 
  20. --- RECORDSEPARATOR ---
  21. options. 
  22. --- RECORDSEPARATOR ---
  23. The "IfNewer" option operates as follows: if both files have internal version 
  24. --- RECORDSEPARATOR ---
  25. numbers, then these numbers are used for comparison, otherwise the dates of the 
  26. --- RECORDSEPARATOR ---
  27. two files are used for comparison. 
  28. --- RECORDSEPARATOR ---
  29. Seven Flags are defined: 
  30. --- RECORDSEPARATOR ---
  31. CP_NOCANCEL 
  32. --- RECORDSEPARATOR ---
  33. 1 
  34. --- RECORDSEPARATOR ---
  35. does not show the Cancel button. 
  36. --- RECORDSEPARATOR ---
  37. CP_NOFILENAME 
  38. --- RECORDSEPARATOR ---
  39. 2 
  40. --- RECORDSEPARATOR ---
  41. does not display the file names while copying. 
  42. --- RECORDSEPARATOR ---
  43. CP_STOPONERROR 
  44. --- RECORDSEPARATOR ---
  45. 4 
  46. --- RECORDSEPARATOR ---
  47. stop copying if an error occurs 
  48. --- RECORDSEPARATOR ---
  49. CP_NODIALOG 
  50. --- RECORDSEPARATOR ---
  51. 8 
  52. --- RECORDSEPARATOR ---
  53. does not show the dialog box 
  54. --- RECORDSEPARATOR ---
  55. CP_CALLBACK 
  56. --- RECORDSEPARATOR ---
  57. 16 
  58. --- RECORDSEPARATOR ---
  59. enable the copy callback handler 
  60. --- RECORDSEPARATOR ---
  61. CP_ANIMATE 
  62. --- RECORDSEPARATOR ---
  63. 32 
  64. --- RECORDSEPARATOR ---
  65. shows system file copying animation (Windows only) 
  66. --- RECORDSEPARATOR ---
  67. CP_SIZEUPDATE 
  68. --- RECORDSEPARATOR ---
  69. 64 
  70. --- RECORDSEPARATOR ---
  71. updates the cal
  72. --- RECORDSEPARATOR ---
  73. lback handler by size 
  74. --- RECORDSEPARATOR ---
  75. You can add any of these flags together to customize the dialog box. 
  76. --- RECORDSEPARATOR ---
  77. To implement the callback handler, use the CP_CALLBACK flag. Typically you 
  78. --- RECORDSEPARATOR ---
  79. would also use the CP_NODIALOG flag and implement your own dialog box. If you 
  80. --- RECORDSEPARATOR ---
  81. use this flag then you need to add a handler called 'baCopyProgressUpdate'. This 
  82. --- RECORDSEPARATOR ---
  83. handler needs to be a movie script. 
  84. --- RECORDSEPARATOR ---
  85. This handler will have two arguments passed into it - the percentage copied so far 
  86. --- RECORDSEPARATOR ---
  87. and the current file being copied. The handler will be called whenever the 
  88. --- RECORDSEPARATOR ---
  89. percentage copied has increased by one, or a new file is being copied. If you 
  90. --- RECORDSEPARATOR ---
  91. specify the CP_SIZEUPDATE, then your handler will be called whenever 
  92. --- RECORDSEPARATOR ---
  93. approximately 64k of data has been copied, rather than by percentage. 
  94. --- RECORDSEPARATOR ---
  95. To stop copying, you can return 1 in your handler; return 0 or no return to continue 
  96. --- RECORDSEPARATOR ---
  97. copying. An example handler is listed below - the update functions would be used 
  98. --- RECORDSEPARATOR ---
  99. to update your own progress dialog. 
  100. --- RECORDSEPARATOR ---
  101. on baCopyProgressUpdate percentage, filename 
  102. --- RECORDSEPARATOR ---
  103. updateProgressBar percentage 
  104. --- RECORDSEPARATOR ---
  105. updateStatus fileName 
  106. --- RECORDSEPARATOR ---
  107. if keyPressed( " " ) then -- if user presses space bar, stop copying 
  108. --- RECORDSEPARATOR ---
  109. return 1 
  110. --- RECORDSEPARATOR ---
  111. end if 
  112. --- RECORDSEPARATOR ---
  113. end 
  114. --- RECORDSEPARATOR ---
  115. The callback handler is only available on Director.